/*
 * To change this template, choose Tools | Templates
 * and open the template in the editor.
 */
package tk.eigh.ksvg.component.filter;

import ksvg.core.SVGFilter;
import org.apache.myfaces.buildtools.maven2.plugin.builder.annotation.JSFComponent;
import org.apache.myfaces.buildtools.maven2.plugin.builder.annotation.JSFProperty;
import tk.eigh.ksvg.types.SVGNumber;

/**
 * <p>This filter primitive creates a rectangle filled with the color and
 * opacity values from properties <a
 * href="http://www.w3.org/TR/SVG/filters.html#FloodColorProperty">‘flood-color’</a>
 * and <a
 * href="http://www.w3.org/TR/SVG/filters.html#FloodOpacityProperty">‘flood-opacity’</a>.
 * The rectangle is as large as the <a
 * href="http://www.w3.org/TR/SVG/filters.html#FilterPrimitiveSubRegion">filter
 * primitive subregion</a> established by the <a
 * href="http://www.w3.org/TR/SVG/filters.html#FilterPrimitiveXAttribute">‘x’</a>,
 * <a
 * href="http://www.w3.org/TR/SVG/filters.html#FilterPrimitiveYAttribute">‘y’</a>,
 * <a
 * href="http://www.w3.org/TR/SVG/filters.html#FilterPrimitiveWidthAttribute">‘width’</a>
 * and <a
 * href="http://www.w3.org/TR/SVG/filters.html#FilterPrimitiveHeightAttribute">‘height’</a>
 * attributes on the <a
 * href="http://www.w3.org/TR/SVG/filters.html#feFloodElement">‘feFlood’</a>
 * element.</p>
 */
@JSFComponent(name = "svg:Flood",
type = "tk.eigh.svg.Flood",
family = "filter.Flood",
clazz = "ksvg.filter.Flood",
tagClass = "ksvg.tags.filter.FloodTag",
defaultRendererType = "filter.SVGFloodRenderer")
public abstract class AbstractFlood extends SVGFilter {

    /**
     * <p>The <a
     * href="http://www.w3.org/TR/SVG/filters.html#FloodColorProperty">‘flood-color’</a>
     * property indicates what color to use to flood the current <a
     * href="http://www.w3.org/TR/SVG/filters.html#FilterPrimitiveSubRegion">filter
     * primitive subregion</a>. The keyword currentColor and ICC colors can be
     * specified in the same manner as within a <a
     * href="http://www.w3.org/TR/SVG/painting.html#SpecifyingPaint">&lt;paint&gt;</a>
     * specification for the <a href="painting.html#FillProperty">‘fill’</a> and
     * <a
     * href="http://www.w3.org/TR/SVG/painting.html#StrokeProperty">‘stroke’</a>
     * properties.</p> <div> <dl><dt
     * id="FloodColorProperty">‘flood-color’</dt><dd> <table
     * summary="flood-color property" cellspacing="0" cellpadding="0"><tr
     * valign="baseline"><td><em>Value:</em>  </td><td>currentColor |<br/> <a
     * href="http://www.w3.org/TR/SVG/types.html#DataTypeColor">&lt;color&gt;</a>
     * [<a
     * href="http://www.w3.org/TR/SVG/types.html#DataTypeICCColor">&lt;icccolor&gt;</a>]
     * |<br/> <a
     * href="http://www.w3.org/TR/2008/REC-CSS2-20080411/cascade.html#value-def-inherit">
     * inherit</a></td></tr><tr
     * valign="baseline"><td><em>Initial:</em>  </td><td>black</td></tr><tr
     * valign="baseline"><td><em>Applies to:</em>  </td><td><a
     * href="http://www.w3.org/TR/SVG/filters.html#feFloodElement">‘feFlood’</a>
     * elements</td></tr><tr
     * valign="baseline"><td><em>Inherited:</em>  </td><td>no</td></tr><tr
     * valign="baseline"><td><em>Percentages:</em>  </td><td>N/A</td></tr><tr
     * valign="baseline"><td><em>Media:</em>  </td><td>visual</td></tr><tr
     * valign="baseline"><td><em><a
     * href="http://www.w3.org/TR/SVG/animate.html#Animatable">Animatable</a>:</em>  </td><td>yes</td></tr></table>
     * </dd></dl> </div> <p>The <a
     * href="http://www.w3.org/TR/SVG/filters.html#FloodOpacityProperty">‘flood-opacity’</a>
     * property defines the opacity value to use across the entire <a
     * href="http://www.w3.org/TR/SVG/filters.html#FilterPrimitiveSubRegion">filter
     * primitive subregion</a>.</p>
     */
    @JSFProperty
    public abstract String getFloodColor();

    /**
     * <p>The <a
     * href="http://www.w3.org/TR/SVG/filters.html#FloodOpacityProperty">‘flood-opacity’</a>
     * property defines the opacity value to use across the entire <a
     * href="filters.html#FilterPrimitiveSubRegion">filter primitive
     * subregion</a>.</p> <div> <dl><dt
     * id="FloodOpacityProperty">‘flood-opacity’</dt><dd> <table
     * summary="flood-opacity property" cellspacing="0" cellpadding="0"><tr
     * valign="baseline"><td><em>Value:</em>  </td><td>&lt;opacity-value&gt; |
     * <a
     * href="http://www.w3.org/TR/2008/REC-CSS2-20080411/cascade.html#value-def-inherit">
     * inherit</a></td></tr><tr
     * valign="baseline"><td><em>Initial:</em>  </td><td>1</td></tr><tr
     * valign="baseline"><td><em>Applies to:</em>  </td><td><a
     * href="http://www.w3.org/TR/SVG/filters.html#feFloodElement">‘feFlood’</a>
     * elements</td></tr><tr
     * valign="baseline"><td><em>Inherited:</em>  </td><td>no</td></tr><tr
     * valign="baseline"><td><em>Percentages:</em>  </td><td>N/A</td></tr><tr
     * valign="baseline"><td><em>Media:</em>  </td><td>visual</td></tr><tr
     * valign="baseline"><td><em><a
     * href="http://www.w3.org/TR/SVG/animate.html#Animatable">Animatable</a>:</em>  </td><td>yes</td></tr></table>
     * </dd></dl> </div>
     */
    @JSFProperty
    public abstract SVGNumber getFloodOpacity();
}